• All Files

API Manual

Purpose

The Purpose of this document is to describe the concept and use of IConduct API powered by the IConduct platform.

Introduction

A. REST API

REST is any interface between systems using HTTP to obtain data and generate operations on those data in all possible formats, such as XML and JSON.

 

B. SOAP API

SOAP is a messaging protocol specification for exchanging structured information in the implementation of web services in computer networks. Its purpose is to induce extensibility, neutrality and independence.

 

C. SUPPORTED FUNCTIONS

The following methods are supported in SOAP API:

  • Execute;
  • GetResult;
  • ExecuteAsync

SUPPORTED CALLS (REST API)

  • Asynchronous Call - asynchronous calls do not block (or wait) for the API call to return from the server. Execution continues in your program, and when the call returns from the server, a "callback" function is executed.
  • Synchronous Call – a synchronous call means that the code execution will be blocked until API call returns from the server. The GET and POST methods are supported.
  • Schema Initialization – the schema will be created with IConduct (only POST method is supported here).

 

A. EXECUTING ASYNCHRONOUS CALL

 

Request Parameters:

URL:

The URL of the async API call ends with the process number of the process you want to execute. The process number can be retrieved from the URL on the process page.

Method:

POST

Username:

yourname@iconductcloud.com

Token:

b0ca0baa-7000-4592-8964-330e7fefca6d (System Users > YourUsername > reset API token)

Content-Type:

Application/JSON

Body:

Key/Value array allows you to initialize default parameters with specific values. Key for the parameter name and Value for the parameter value.

Sample Call:

Request URL:http://www10.iconductcloud.com/api/v8/api.svc/json/ExecuteAsync/12345

Method:

POST

Headers:

  • Username: yourname@iconductcloud.com
  • Token: b0ca0baa-7000-4592-8964-330e7fefca6d (System Users > YourUsername > reset API token)
  • Content-Type: application/json

Body:

JSON
{ "parameters":[ { "Key":"param1", "Value":"123" }, { "Key":"p aram2", "Value":"456" } ] }

Response:

JSON

{ "ExecutionStatus": "Success", "Message": "Success", "StartTime": "2016-07-27

18:26:00", "EndTime": "2016-07-27 18:26:00", "Schema": null }

 

B. EXECUTING SYNCHRONOUS CALL (POST)

 

Ask the IConduct to execute process and wait for the process to finish. The response will return success if processes initiated and error if process could not initiate. Schema in response will always be null.

Request Parameters:

URL:

The URL of the sync API call ends with the process number of the process you want to execute. The process number can be retrieved from the URL when on the process page. You can add option timeout in the field second to the URL.

Method:

POST

Headers:

  • Username: yourname@iconductcloud.com
  • Token:b0ca0baa-7000-4592-8964-330e7fefca6d(System Users > YourUsername > reset API token)
  • Content-Type: application/JSON.

Body:

Key/Value array allows you to initialize default parameters with specific values. Key for the parameter name and Value for the parameter value.

Sample Call:

Request URL:

http://www10.iconductcloud.com/api/v8/api.svc/json/Execute/12345?timeout=60

Method:

POST

Headers:

  • Username: yourname@iconductcloud.com
  • Token:b0ca0baa-7000-4592-8964-330e7fefca6d (System Users > YourUsername > reset API token)
  • Content-Type: application/json

Body:

JSON
{ "parameters":[ { "Key":"param1", "Value":"123" }, { "Key":"p aram2", "Value":"456" } ] }

 

Response:

JSON

{ "ExecutionStatus": "Success", "Message": "Success", "StartTime": "2016-07-27

18:26:00", "EndTime": "2016-07-27 18:26:00", "Schema": null }

 

C. EXECUTING SYNCHRONOUS CALL (GET)

 

Ask the IConduct to execute process and wait for the process to finish. The response will return success if processes initiated, and error if process could not initiate. Schema in response will contain all the process schema columns defined in the first "Return schema to Web Service" step.

Request Parameters:

URL:

The URL of the sync and get result API call ends with the process number of the process you want to execute. The process number can be retrieved from the URL when on the process page. You can add option timeout in the field second to the URL.

Method:

POST

Headers:

  • Username: yourname@iconductcloud.com
  • Token:b0ca0baa-7000-4592-8964-330e7fefca6d (System Users > YourUsername > reset API token)
  • Content-Type: application/JSON.

Body:

Key/Value array allows you to initialize default parameters with specific values. Key for the parameter name and Value for the parameter value.